-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: add guidelines for building the docs #5996
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: add guidelines for building the docs #5996
Conversation
sexy! maybe add how to show the deps: I think this could form the basis for a new major doc section (in addition to a README), say 'Contributing To Pandas'? (and also add in all of the developer links / docs as well (at some point), so that everything is in the main docs http://pandas.pydata.org/developers.html (IOW this link would refer back to the Contributing to Pandas page itself) |
Looks nice so far. I also started throwing in some notes about the things I encounter here. |
@jreback Included the @y-p @Kermit666 @phaebz Any futher comments, unclear or incorrect guidelines? |
@jorisvandenbossche I think you should add as a section to the main docs (I know you want to reorganize them at some point)....but I think they will get a lot more visibility this way my 2c. (you can put them near the end) |
|
||
.. warning:: | ||
|
||
Attention! Building the docs with Sphinx version 1.2 is broken. Use the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no need for acthung, it's already a warning.
looks good to me. |
.. contents:: Table of contents: | ||
|
||
|
||
About the Pandas documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have an official ruling on whether the name of this great library we all work on is ever capitalized? In Wes's book I think it was always lowercase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
grep -nr Pandas doc/source
reveals quite a few uppercase Pandas, so maybe its OK (or those all need to be "fixed").
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But I also did it inconsistently :-) (only in the headers with uppercase, in text it was also lowercase). So changed all to lowercase.
Looks good to me. I left a small comment about the documentation format with a link. I don't know why didn't GitHub put it here as well. Here it is once again just in case:
|
+ link to README.rst in /docs
I incorporated some of the comments. Thanks for them! @Kermit666 I think it is because you commented on the the commit. Most of the time comments are added on the "Files changed" tab at the PR, and then it certainly shows up here. @jreback I added a section on contributing in the main documentation, but for now just included the README.rst so it is visible in the main docs. And this section can then be expanded later. |
bumped to 0.14.0, not a blocker. |
OK, further tweaks/additions can always be made later, merging for now. |
DOC: add guidelines for building the docs
@y-p if you have a chance can you rebuild docs at some point? |
docs are up. |
looks great! thanks @jorisvandenbossche contributing section looks nice! |
First draft of some guidelines on contributing to and building the docs (following #5934). Comments are very welcome.
Rendered version can be seen here: https://github.com/jorisvandenbossche/pandas/blob/doc-guide/doc/README.rst
TODO: